Buenas prácticas en Bioinformática e Introducción a Markdown

class: title-slide, middle, center
background-image: url(data:image/png;base64,#figures/Clases_Rladies_Slide1_reproducible.png) 
background-position: 90% 75%, 75% 75%, center
background-size: 1210px,210px, cover

.center-column[
# Buenas prácticas en Bioinformática e Introducción a Markdown
### ⚔<br/>Aspectos generales

####Dra. Evelia Coss 
#### 08/18/2025
]

.left[.footnote[R-Ladies Theme[R-Ladies Theme](https://www.apreshill.com/project/rladies-xaringan/)]]

---
background-image: url(data:image/png;base64,#figures/liigh_unam_logo.png) 
background-position: 10% 10%
background-size: 10%
class: middle, center

# Sobre mi
----

.left-col[

### <svg aria-hidden="true" role="img" viewBox="0 0 448 512" style="height:1em;width:0.88em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:#181818;overflow:visible;position:relative;"><path d="M416 0c17.7 0 32 14.3 32 32c0 59.8-30.3 107.5-69.4 146.6c-28 28-62.5 53.5-97.3 77.4l-2.5 1.7c-11.9 8.1-23.8 16.1-35.5 23.9l0 0 0 0 0 0-1.6 1c-6 4-11.9 7.9-17.8 11.9c-20.9 14-40.8 27.7-59.3 41.5H283.3c-9.8-7.4-20.1-14.7-30.7-22.1l7-4.7 3-2c15.1-10.1 30.9-20.6 46.7-31.6c25 18.1 48.9 37.3 69.4 57.7C417.7 372.5 448 420.2 448 480c0 17.7-14.3 32-32 32s-32-14.3-32-32H64c0 17.7-14.3 32-32 32s-32-14.3-32-32c0-59.8 30.3-107.5 69.4-146.6c28-28 62.5-53.5 97.3-77.4c-34.8-23.9-69.3-49.3-97.3-77.4C30.3 139.5 0 91.8 0 32C0 14.3 14.3 0 32 0S64 14.3 64 32H384c0-17.7 14.3-32 32-32zM338.6 384H109.4c-10.1 10.6-18.6 21.3-25.5 32H364.1c-6.8-10.7-15.3-21.4-25.5-32zM109.4 128H338.6c10.1-10.7 18.6-21.3 25.5-32H83.9c6.8 10.7 15.3 21.3 25.5 32zm55.4 48c18.4 13.8 38.4 27.5 59.3 41.5c20.9-14 40.8-27.7 59.3-41.5H164.7z"/></svg> Dra. Evelia Lorena Coss-Navarrete

Investigadora Posdoctoral en el Laboratorio Internacional de Investigación sobre el Genoma Humano [(LIIGH), UNAM](https://twitter.com/LIIGH_UNAM), campus Juriquilla

[<svg aria-hidden="true" role="img" viewBox="0 0 640 512" style="height:1em;width:1.25em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M579.8 267.7c56.5-56.5 56.5-148 0-204.5c-50-50-128.8-56.5-186.3-15.4l-1.6 1.1c-14.4 10.3-17.7 30.3-7.4 44.6s30.3 17.7 44.6 7.4l1.6-1.1c32.1-22.9 76-19.3 103.8 8.6c31.5 31.5 31.5 82.5 0 114L422.3 334.8c-31.5 31.5-82.5 31.5-114 0c-27.9-27.9-31.5-71.8-8.6-103.8l1.1-1.6c10.3-14.4 6.9-34.4-7.4-44.6s-34.4-6.9-44.6 7.4l-1.1 1.6C206.5 251.2 213 330 263 380c56.5 56.5 148 56.5 204.5 0L579.8 267.7zM60.2 244.3c-56.5 56.5-56.5 148 0 204.5c50 50 128.8 56.5 186.3 15.4l1.6-1.1c14.4-10.3 17.7-30.3 7.4-44.6s-30.3-17.7-44.6-7.4l-1.6 1.1c-32.1 22.9-76 19.3-103.8-8.6C74 372 74 321 105.5 289.5L217.7 177.2c31.5-31.5 82.5-31.5 114 0c27.9 27.9 31.5 71.8 8.6 103.9l-1.1 1.6c-10.3 14.4-6.9 34.4 7.4 44.6s34.4 6.9 44.6-7.4l1.1-1.6C433.5 260.8 427 182 377 132c-56.5-56.5-148-56.5-204.5 0L60.2 244.3z"/></svg> Dra Alejandra Medina-Rivera](https://liigh.unam.mx/profile/dra-alejandra-medina-rivera/)

[<svg aria-hidden="true" role="img" viewBox="0 0 496 512" style="height:1em;width:0.97em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> EveliaCoss.github.io](https://eveliacoss.github.io/)

]

.center-col[

### <svg aria-hidden="true" role="img" viewBox="0 0 576 512" style="height:1em;width:1.12em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:#181818;overflow:visible;position:relative;"><path d="M287.9 0c9.2 0 17.6 5.2 21.6 13.5l68.6 141.3 153.2 22.6c9 1.3 16.5 7.6 19.3 16.3s.5 18.1-5.9 24.5L433.6 328.4l26.2 155.6c1.5 9-2.2 18.1-9.7 23.5s-17.3 6-25.3 1.7l-137-73.2L151 509.1c-8.1 4.3-17.9 3.7-25.3-1.7s-11.2-14.5-9.7-23.5l26.2-155.6L31.1 218.2c-6.5-6.4-8.7-15.9-5.9-24.5s10.3-14.9 19.3-16.3l153.2-22.6L266.3 13.5C270.4 5.2 278.7 0 287.9 0zm0 79L235.4 187.2c-3.5 7.1-10.2 12.1-18.1 13.3L99 217.9 184.9 303c5.5 5.5 8.1 13.3 6.8 21L171.4 443.7l105.2-56.2c7.1-3.8 15.6-3.8 22.6 0l105.2 56.2L384.2 324.1c-1.3-7.7 1.2-15.5 6.8-21l85.9-85.1L358.6 200.5c-7.8-1.2-14.6-6.1-18.1-13.3L287.9 79z"/></svg> Miembro

- [LupusRGMX](https://twitter.com/LupusRgmx)
- [Proyecto JAGUAR](https://twitter.com/PJaguarLATAM)
- [Rladies Morelia](https://www.facebook.com/profile.php?id=100093337606435)
- [CDSB - Mexico](https://twitter.com/CDSBMexico)
- [RIABIO](https://twitter.com/RiaBioNet)
- [The Carpentries](https://carpentries.org/index.html)
- [ISCB-RSG Mexico](https://rsg-mexico.iscbsc.org/)
- [ISCB Wikipedia team](https://x.com/iscbwikiteam)
]

.right-col[

### <svg aria-hidden="true" role="img" viewBox="0 0 512 512" style="height:1em;width:1em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:#181818;overflow:visible;position:relative;"><path d="M418.4 157.9c35.3-8.3 61.6-40 61.6-77.9c0-44.2-35.8-80-80-80c-43.4 0-78.7 34.5-80 77.5L136.2 151.1C121.7 136.8 101.9 128 80 128c-44.2 0-80 35.8-80 80s35.8 80 80 80c12.2 0 23.8-2.7 34.1-7.6L259.7 407.8c-2.4 7.6-3.7 15.8-3.7 24.2c0 44.2 35.8 80 80 80s80-35.8 80-80c0-27.7-14-52.1-35.4-66.4l37.8-207.7zM156.3 232.2c2.2-6.9 3.5-14.2 3.7-21.7l183.8-73.5c3.6 3.5 7.4 6.7 11.6 9.5L317.6 354.1c-5.5 1.3-10.8 3.1-15.8 5.5L156.3 232.2z"/></svg> Formación académica

- Doctorado en Biotecnología de Plantas, [Cinvestav, Langebio](https://twitter.com/uga_langebio),  [<svg aria-hidden="true" role="img" viewBox="0 0 640 512" style="height:1em;width:1.25em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M579.8 267.7c56.5-56.5 56.5-148 0-204.5c-50-50-128.8-56.5-186.3-15.4l-1.6 1.1c-14.4 10.3-17.7 30.3-7.4 44.6s30.3 17.7 44.6 7.4l1.6-1.1c32.1-22.9 76-19.3 103.8 8.6c31.5 31.5 31.5 82.5 0 114L422.3 334.8c-31.5 31.5-82.5 31.5-114 0c-27.9-27.9-31.5-71.8-8.6-103.8l1.1-1.6c10.3-14.4 6.9-34.4-7.4-44.6s-34.4-6.9-44.6 7.4l-1.1 1.6C206.5 251.2 213 330 263 380c56.5 56.5 148 56.5 204.5 0L579.8 267.7zM60.2 244.3c-56.5 56.5-56.5 148 0 204.5c50 50 128.8 56.5 186.3 15.4l1.6-1.1c14.4-10.3 17.7-30.3 7.4-44.6s-30.3-17.7-44.6-7.4l-1.6 1.1c-32.1 22.9-76 19.3-103.8-8.6C74 372 74 321 105.5 289.5L217.7 177.2c31.5-31.5 82.5-31.5 114 0c27.9 27.9 31.5 71.8 8.6 103.9l-1.1 1.6c-10.3 14.4-6.9 34.4 7.4 44.6s34.4 6.9 44.6-7.4l1.1-1.6C433.5 260.8 427 182 377 132c-56.5-56.5-148-56.5-204.5 0L60.2 244.3z"/></svg> Dra Selene Fernandez-Valverde](https://twitter.com/SelFdz)
- Maestría en Biotecnología de Plantas, [Cinvestav, Unidad Irapuato](https://twitter.com/CinvestavIra)
- Ing. en Biotecnología, [UPSIN](https://www.facebook.com/UPSINSINALOA)

]

---
class: inverse, center, middle

## Un algoritmo nos permite resolver un problema ⭐

Un algoritmo es un método para resolver un problema mediante una serie de pasos **definidos, precisos y finitos.**

- **Definido:** si se sigue dos veces, se obtiene el mismo resultado. Es reproducible.
- **Preciso:** implica el orden de realización de cada uno de los pasos.
- **Finito:** Tiene un numero determinado de pasos, implica que tiene un fin.

> Un algoritmo podemos definirlo como un **programa o software.**

<img src="data:image/png;base64,#figures/allison-horst-code-kitchen.png" width="60%" style="display: block; margin: auto;" />
.left[.footnote[.black[
Imagen tomada de: [Allison Horst](https://allisonhorst.com/allison-horst) 
]]]

---

## Para escribir un buen software necesitas:

> Escribir código mantenible (maintainable code), usar control de versiones (version control) y rastreadores de problemas (issue trackers), revisiones de código (code reviews), pruebas unitarias (unit testing) y automatización de tareas (task automation).
>
> Wilson, *et al.* 2014. *PLOS Biology*

<img src="data:image/png;base64,#figures/what-code-quality-1.jpg" width="60%" style="display: block; margin: auto;" />
.left[.footnote[.black[
Imagen tomada de: https://devcom.com/tech-blog/code-quality-definition-how-to-improve-code-quality/
]]]

---

## Pasos para escribir un buen software

.pull-left[
1. Análisis del problema / Definir el problema

2. Diseño del algoritmo / Diseño del programa

3. Codificación / Escribir el código

4. Compilación y ejecución del programa

5. Verificación / Realizar pruebas

6. Depuración / Detectar los errores y corregirlos
> Programacion defensiva

7. Documentación
]

.pull-right[

<img src="data:image/png;base64,#figures/homersapien.jpg" width="80%" style="display: block; margin: auto;" />
]

---

## Paso 7: Documentación

.left[.footnote[.black[
Imagen tomada de: [Allison Horst](https://allisonhorst.com/allison-horst) 
]]]

---

## Correcta documentación de nuestro código

.content-box-blue[

- **Título:** (opcional)

- **Autor (author):** Su nombre

- **Dia (date):** Fecha de creación

- **Paquetes** (packages)

- **Directorio de trabajo (Working directory):** En que carpeta se encuentra tu datos y programa.

- **Información descriptiva del programa (Description):** ¿Para qué sirve el programa? Ej: El siguiente programa realiza la suma de dos numeros enteros a partir de la entrada del usuario y posteriormente la imprime en pantalla.

- **Usage ¿Cómo se utiliza?**

- **Argumentos (Arguments)**

+ Información de entrada (Data Inputs): Ej: Solo numeros enteros (sin decimales).

+ Información de salida (Outpus): Graficas, figuras, tablas, etc.

]

---

---

## Puntos claves para buenas practicas en bioinfo ⭐

1. Escriba **programas para personas, no para computadoras** (Documenta qué hace y por qué). - Se coherente en la nomenclatura, indentación y otros aspectos del estilo.

2. Divide los programas en funciones cortas de un solo propósito. 💻 📚

3. **No repitas tu código.** Crea pasos reproducibles o que se repitan por si solas. ➰

4. Planifique los errores (**Programacion defensiva**) 🚩

5. Optimice el software sólo después de que funcione correctamente. - Si funciona no lo modifiques, simplificalo.

6. Colaborar - Busque siempre bibliotecas de software bien mantenidas que hagan lo que necesita. 👥

> Ejemplo de como realizo mis documentos 💜
> Aqui les dejo el script que les doy a mis alumnos [VisualizacionDatos.R](https://github.com/EveliaCoss/RNAseq_classFEB2024/blob/main/Practica_Dia3/scripts/VisualizacionDatos.R) del curso de [Análisis de datos de RNA-Seq](https://github.com/EveliaCoss/RNAseq_classFEB2024).

---
class: inverse, center, middle

## ¿Qué es Markdown?

Markdown es un **lenguaje de marcado ligero** que permite añadir elementos de formato a documentos de *texto plano*. Creado por John Gruber en 2004, Markdown es actualmente uno de los lenguajes más populares del mundo.

- Sencillo y legible, sin necesidad de usar editores complicados o HTML.
- **lenguaje de marcado ligero:** Escribir texto que incluye instrucciones simples para darle formato.

### 🧩 ¿Por qué se llama “ligero”?

Porque:

- Usa símbolos sencillos como `*, #,` o `-` para indicar formato.
- No requiere cerrar etiquetas como `<strong> o <div>` (como en HTML).
- Es minimalista y limpio, ideal para escribir rápido sin distracciones.

---

## 🧠 ¿Para qué se usa?

- Crear documentación técnica o científica
- Escribir **README.md** en proyectos de GitHub
- Generar contenido para sitios web
- Crear [tesis](https://quarto.org/docs/get-started/hello/rstudio.html), notas, [libros](https://bookdown.org/yihui/rmarkdown-cookbook/), [presentaciones](https://bookdown.org/yihui/rmarkdown/xaringan.html) y posters

.panelset[
.panel[.panel-name[En R]

| Paquete / Programa     | Uso principal                                                                 |
|------------------------|-------------------------------------------------------------------------------|
| `rmarkdown`            | Crear documentos reproducibles con texto, código y resultados                |
| `knitr`                | Ejecutar chunks de código en RMarkdown                                       |
| `Quarto`               | Plataforma moderna para documentos con R, Python, etc.                       |
| `bookdown`             | Crear libros técnicos con Markdown + RMarkdown                               |
| `blogdown`             | Generar blogs científicos usando Markdown y Hugo                             |
| `flexdashboard`        | Dashboards interactivos escritos en Markdown                                 |

]

.panel[.panel-name[En Python]

| Paquete / Programa     | Uso principal                                                                 |
|------------------------|-------------------------------------------------------------------------------|
| Jupyter Notebooks      | Celdas Markdown para explicar y documentar junto con código                  |
| `Quarto`               | Igual que en R, permite combinar Markdown con código Python                  |
| `mkdocs`               | Generar sitios web de documentación técnica desde archivos Markdown          |
| `Sphinx + MyST`        | Documentación avanzada con soporte para Markdown                             |
| `markdown`, `mistune`  | Librerías para convertir Markdown a HTML                                     |
| `nbconvert`            | Exportar notebooks con Markdown a PDF, HTML, LaTeX, etc.                     |

]
]

---

## ¿Cómo funciona?

Pasos generales:

1. Crear un archivo Markdown con un editor de texto o una aplicación específica. El archivo debe tener la extensión `.md o .markdown`.
2. Se abre el archivo Markdown en una aplicación Markdown.
3. Se utiliza la aplicación Markdown para convertir el archivo Markdown en un documento HTML.
4. Visualización del archivo HTML en un navegador web o use la aplicación Markdown para convertirlo a otro formato de archivo, como PDF.

.content-box-gray[
La aplicación y el procesador de Markdown son dos componentes independientes. Para simplificar, los he combinado en un solo elemento ("aplicación de Markdown") en la figura a continuación.
]

.left[.footnote[.black[
Imagen tomada de: https://www.markdownguide.org/getting-started/
]]]

---

## Markdown app: Visual Studio Code

**Visual Studio Code** es un editor de código que combina las funcionalidades de un entorno de desarrollo integrado (IDE) con la simplicidad de un editor de texto.

.pull-left[

#### ¿Por qué se usa?

- **VS Code** es gratuito y de código abierto
- Multiplataforma (Windows, macOS y Linux)
- Control de versiones integrado
- Amplia gama de extensiones

]

.pull-right[

#### La interfaz de usuario

Al iniciar **VS Code** por primera vez encontraremos interfaz limpia y minimalista. Aunque pueda parecer simple a primera vista, la interfaz de VS Code es extremadamente poderosa y personalizable.

]

Vamos a instalarlo de acuerdo a [nuestra plataforma](https://code.visualstudio.com/).

---